Skip to content

Add Python clickhouse-migrations to schema migration tools (and disambiguate the Node.js entry)#6477

Open
zifter wants to merge 1 commit into
ClickHouse:mainfrom
zifter:add-python-clickhouse-migrations
Open

Add Python clickhouse-migrations to schema migration tools (and disambiguate the Node.js entry)#6477
zifter wants to merge 1 commit into
ClickHouse:mainfrom
zifter:add-python-clickhouse-migrations

Conversation

@zifter

@zifter zifter commented Jul 1, 2026

Copy link
Copy Markdown

Summary

The Schema migration tools for ClickHouse knowledge-base page lists clickhouse-migrations in the "Other Tools in the Ecosystem" table, but the link points to the npm / Node.js package. There is a separate, actively maintained Python project of the same name that isn't represented:

This PR:

  • Renames the existing row to clickhouse-migrations (Node.js) so the name collision between the two projects is explicit.
  • Adds clickhouse-migrations (Python) — a file-based schema migration runner available both as a CLI and as a Python library, with single-node and cluster (ON CLUSTER / replicated) support, --dry-run and --fake modes, and multi-statement migration files. Supports Python 3.9–3.14, MIT licensed.

Only the one table in knowledgebase/schema_migration_tools.md is changed; no other content is touched.

Why

Readers searching for a Python-native ClickHouse migration tool currently see only Houseplant and Alembic, and the same-named Node.js entry is easy to mistake for the Python package. Disambiguating the name and listing the Python project makes the ecosystem table accurate and more useful.

@zifter zifter requested a review from a team as a code owner July 1, 2026 21:35
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

@zifter is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants